Getting Started
Cloning the repository
The source code is available here and can be cloned by using:
git clone https://gitlab.ethz.ch/mechanics-and-materials/aqcnes.git
This will make a new directory called aqcnes in the current working directory. The following table gives an overview of the files and subdirectories in the source code:
| Directory | Contents |
|---|---|
| cmake | dependency discovery and unit test declarartion |
| data | sample user input json files and their schemas |
| container | dockerfile to build a docker image with all dependencies |
| docs | documentation markdown scripts |
| examples | resources for the exercises on this page |
| requirements | required modules to run on the ETH HPC cluster |
| src | AQCNES source files |
| README.md | short description of the software |
Dependencies
Building AQCNES locally requires the installation of some dependencies which can be easily done using the commands in container/Dockerfile.
Alternatively, you can also build AQCNES in a build container (e.g. docker or podman).
The mesh building and repair functionality of AQCNES is outsourced to a separate repository, known as qcmesh. The source code for qcmesh is available here.
Installing docker
Detailed environment dependent installation instructions can be found here. However, we provide here a short summary for Linux Ubuntu users.
sudo apt install gnome-terminal
sudo apt-get update
sudo apt-get install ./docker-desktop-<version>-<arch>.deb
After successfull installation, the docker verison can be checked using:
docker --version